/*-
 * SMSEntry.java
 *
 * $LastChangedBy:  $
 * $LastChangedRevision:  $
 * $LastChangedDate:  $
 * $HeadURL: $
 *
 * Copyright (c) 2008, Stein Gunnar Bakkeby
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Stein Gunnar Bakkeby nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.googlecode.attention;

import java.io.Serializable;

public interface SMSEntry extends Serializable {

  /**
   * This will return the memory index of
   * the PDUEntry in the preferred storage.
   * 
   * @return The index
   */
  int getMemoryIndex();
  
  /**
   * This will return the status of the PDUEntry.
   * 
   * @return The status
   * @see Status
   */
  Status getStatus();
  
  /**
   * String type alphanumeric representation of <da> or <oa>
   * corresponding to the entry found in phonebook; implementation
   * of this feature is manufacturer specific.
   * 
   * @return Implementation specific alphanumeric DA or OA 
   */
  String getAlpha();
  
  /**
   * This will return the length of the PDUEntry.
   * 
   * @return The length
   */
  int getLength();
  
  /**
   * This will return the PDU as received from the phone. This can be decoded
   * using the SMS package, although service centre numbers may have to be
   * removed manually beforehand.
   * 
   * @return The PDU of the SMS message
   * @see com.googlecode.attention.sms.pdu.TPDU
   */
  String getPDU();
}
